feat: support role assignment for scopes that don't exist yet - #369
feat: support role assignment for scopes that don't exist yet#369efortish wants to merge 3 commits into
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @efortish! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
mariajgrimaldi
left a comment
mariajgrimaldi
left a comment
There was a problem hiding this comment.
Can we deploy this into our sandbox that already has data to test? Thanks!
| CourseScope.objects.filter( | ||
| external_key=str(instance.id), course_overview__isnull=True | ||
| ).update(course_overview=instance) |
There was a problem hiding this comment.
Don't we have a method for this so we don't use the model directly?
| ContentLibraryScope.objects.filter( | ||
| external_key=str(instance.library_key), content_library__isnull=True | ||
| ).update(content_library=instance) |
There was a problem hiding this comment.
Same question here: don't we have a method for this so we don't use the model directly?
| # This is the only way to find a scope back again when its FK to that object is still null | ||
| # (see get_or_create_for_external_key() in openedx_authz/models/scopes.py) so it can be | ||
| # linked up once the object is created (see openedx_authz/handlers.py backfill receivers). | ||
| external_key = models.CharField(max_length=255, null=True, blank=True, unique=True, db_index=True) |
There was a problem hiding this comment.
Should it be indexed? Is it needed? Also, should it be unique?
| content_library = ContentLibrary.objects.get_by_key(library_key) | ||
| scope, _ = cls.objects.get_or_create(content_library=content_library) | ||
| try: | ||
| content_library = ContentLibrary.objects.get_by_key(library_key) |
There was a problem hiding this comment.
Don't we have a method for checking this?
| try: | ||
| course_overview = CourseOverview.get_from_id(course_key) | ||
| except CourseOverview.DoesNotExist: | ||
| # The course doesn't exist yet: key the row by its external_key so it can be | ||
| # found and linked up later by the backfill signal in openedx_authz/handlers.py. |
There was a problem hiding this comment.
Same question here about having a method to check this, if I remember correctly it's called exists()
4 participants
Description
During course rerun,
edx-platformneeds to grant a user the instructor/staff role on the destination course key before that course'sCourseOverviewexists yet (the clone happens after role assignment would ideally occur). Todayopenedx-authzcrashes in that case, soedx-platform(PR #38840) works around it with authz-specific branching that defers role assignment until after the course is cloned, plus a fallback check elsewhere in the meantime.The actual crash:
CourseScope.get_or_create_for_external_key()/ContentLibraryScope.get_or_create_for_external_key()callCourseOverview.get_from_id()/ContentLibrary.objects.get_by_key(), both of which raiseDoesNotExistwhen the course/library isn't created yet.This PR makes role assignment tolerant of that: the
Scoperow is created with its object FK leftNone, and gets linked up automatically once the realCourseOverview/ContentLibraryis saved.Out of scope
Reverting the
edx-platformPR #38840 workaround is explicit follow-up called out in the issue thread, not part of this change. The REST API'sscope.exists()validation (rest_api/v1/serializers.py) is untouched — it's an intentional, separate guard for untrusted HTTP callers; this fix only affects the internal Python API path used directly by trusted platform code (e.g.student/roles.py'sauthz_add_role).Solves #352